﻿/* 
 * Shuriken is the legal property of its developers. Please refer to the
 * COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;
using System.Text;

namespace Shuriken.Base
{
    public interface IAction : IObject
    {
        /// <summary>
        /// Execute the action 
        /// </summary>
        /// <param name="subject">subject to execute on</param>
        void Execute(ISubject subject);

        bool CanExecuteOn(ISubject subject);

        /// <summary>
        /// Retrieves the type of subject this action is executed on
        /// </summary>
        Type SubjectType
        {
            get;
        }

        /// <summary>
        /// Default Action
        /// </summary>
        bool IsDefault
        {
            get;
        }

        /// <summary>
        /// Gets the reference to the action's attribute
        /// </summary>
        /// <remarks>
        /// Gets the reference to the action's attribute. It returns null if the action does not need an attribute. 
        /// </remarks>
        string ActionAttribute
        {
            get;
            set;
        }

        /// <summary>
        /// Returns true if the action needs an attribute
        /// </summary>
        bool IsAttributed
        {
            get;
        }

    }
}
